kanzi::ScrollView2D Class Reference

Use the Scroll View 2D node to create an input plane to enable user input from gestures. More...

#include <kanzi/ui/node/scroll_view2d.hpp>

Inheritance diagram for kanzi::ScrollView2D:
kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D > kanzi::Node2D kanzi::ScrollViewConcept kanzi::Node kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Member Functions

optional< Vector2calculatePanPosition (const optional< Vector2 > &point) const
 Kanzi internally uses this function to calculate the pan position based on input point, compares it to the previous input point, and provides these values to the interpolators. More...
 
optional< Vector2calculatePanPosition (const InputManipulator::InputMessageArguments &arguments) const
 Kanzi internally uses this function to extract input point from message arguments and calls calculatePanPosition(const optional<Vector2>& point). More...
 
- Public Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
 ~ScrollViewConceptImpl ()
 Destructor. More...
 
PanManipulatorSharedPtr getPanManipulator () const
 Returns the pan manipulator. More...
 
Vector2 getScrollAxis () const
 Gets the value of the ScrollAxisProperty. More...
 
void setScrollAxis (Vector2 value)
 Sets the value of the ScrollAxisProperty. More...
 
float getRecognitionThreshold () const
 Gets the value of the RecognitionThresholdProperty. More...
 
void setRecognitionThreshold (float value)
 Sets the value of the RecognitionThresholdProperty. More...
 
int getMinimumNumberOfTouches () const
 Gets the value of the MinimumNumberOfTouchesProperty. More...
 
void setMinimumNumberOfTouches (int value)
 Sets the value of the MinimumNumberOfTouchesProperty. More...
 
int getMaximumNumberOfTouches () const
 Gets the value of the MaximumNumberOfTouchesProperty. More...
 
void setMaximumNumberOfTouches (int value)
 Sets the value of the MaximumNumberOfTouchesProperty. More...
 
float getSensitivity () const
 Gets the value of the SensitivityProperty. More...
 
void setSensitivity (float value)
 Sets the value of the SensitivityProperty. More...
 
float getSlidingAccelerationCoefficient () const
 Gets the value of the SlidingAccelerationCoefficientProperty. More...
 
void setSlidingAccelerationCoefficient (float value)
 Sets the value of the SlidingAccelerationCoefficientProperty. More...
 
float getSlidingDragCoefficient () const
 Gets the value of the SlidingDragCoefficientProperty. More...
 
void setSlidingDragCoefficient (float value)
 Sets the value of the SlidingDragCoefficientProperty. More...
 
float getDraggingAccelerationCoefficient () const
 Gets the value of the DraggingAccelerationCoefficientProperty. More...
 
void setDraggingAccelerationCoefficient (float value)
 Sets the value of the DraggingAccelerationCoefficientProperty. More...
 
float getDraggingDragCoefficient () const
 Gets the value of the DraggingDragCoefficientProperty. More...
 
void setDraggingDragCoefficient (float value)
 Sets the value of the DraggingDragCoefficientProperty. More...
 
float getDraggingImpulseFactor () const
 Gets the value of the DraggingImpulseFactorProperty. More...
 
void setDraggingImpulseFactor (float value)
 Sets the value of the DraggingImpulseFactorProperty. More...
 
float getSwipeDistance () const
 Gets the value of the SwipeDistanceProperty. More...
 
void setSwipeDistance (float value)
 Sets the value of the SwipeDistanceProperty. More...
 
Vector2 getScrollPosition () const
 Gets the value of the ScrollPositionProperty. More...
 
void setScrollPosition (Vector2 value)
 Sets the value of the ScrollPositionProperty. More...
 
Vector2 getScrollTargetPosition () const
 Gets the value of the ScrollTargetPositionProperty. More...
 
void setScrollTargetPosition (Vector2 value)
 Sets the value of the ScrollTargetPositionProperty. More...
 
Vector2 getScrollSpeed () const
 Gets the value of the ScrollSpeedProperty. More...
 
void setScrollSpeed (Vector2 value)
 Sets the value of the ScrollSpeedProperty. More...
 
bool isScrolling () const
 Gets the value of the ScrollingProperty. More...
 
void setScrolling (bool value)
 Sets the value of the ScrollingProperty. More...
 
bool isDragging () const
 Checks whether a finger is on the surface. More...
 
bool isZoomAffectsScrolling () const
 Gets the value of the ZoomAffectsScrollingProperty. More...
 
void setZoomAffectsScrolling (bool value)
 Sets the value of the ZoomAffectsScrollingProperty. More...
 
Vector2 getScrollBoundsMinimum () const
 Gets the value of the ScrollBoundsMinimumProperty. More...
 
void setScrollBoundsMinimum (Vector2 value)
 Sets the value of the ScrollBoundsMinimumProperty. More...
 
Vector2 getScrollBoundsMaximum () const
 Gets the value of the ScrollBoundsMaximumProperty. More...
 
void setScrollBoundsMaximum (Vector2 value)
 Sets the value of the ScrollBoundsMaximumProperty. More...
 
void setEnabledX (bool state)
 Sets whether the scroll view scrolls along the x axis. More...
 
void setEnabledY (bool state)
 Sets whether the scroll view scrolls along the y axis. More...
 
bool isEnabledX () const
 Returns whether the scroll view scrolls along the x axis. More...
 
bool isEnabledY () const
 Returns whether the scroll view scrolls along the y axis. More...
 
void setLoopingXEnabled (bool value)
 Sets the value of the LoopingXEnabledProperty. More...
 
void setLoopingYEnabled (bool value)
 Sets the value of the LoopingYEnabledProperty. More...
 
bool isLoopingXEnabled () const
 Gets the value of the LoopingXEnabledProperty. More...
 
bool isLoopingYEnabled () const
 Gets the value of the LoopingYEnabledProperty. More...
 
void setScrollBoundsX (float minimum, float maximum)
 Sets the bounds on the x axis. More...
 
void setScrollBoundsY (float minimum, float maximum)
 Sets the bounds on the y axis. More...
 
void scrollToPosition (Vector2 scrollPosition)
 Sets the value for the scroll position within a Scroll View and starts scrolling to that value. More...
 
void scrollToPositionLooping (Vector2 scrollPosition)
 If you enabled the axis looping for a Scroll View, Kanzi uses the shortest path to the target value. More...
 
void jumpToPosition (Vector2 scrollPosition)
 Sets the value for a scroll position within a Scroll View and goes to that position immediatelly without scrolling. More...
 
Vector2 getScroll () const
 Gets the values of the current scroll position of a Scroll View. More...
 
Vector2 getScrollTarget () const
 Gets the values of the scroll position of a Scroll View to which the Scroll View is scrolling. More...
 
Vector2 getScrollTargetLooping () const
 When you enable looping, returns the scroll position value normalized to the allowed range of a Scroll View. More...
 
Vector2 getSpeed () const
 Queries the interpolator for the current speed. More...
 
void scroll (ScrollDirection direction)
 Sets the scroll delta to one step and starts scrolling in that direction. More...
 
void scroll (ScrollPage direction)
 Sets the scroll delta to one distance of the layout height of a Scroll View and starts scrolling in that direction. More...
 
void scroll (ScrollEdge direction)
 Sets the scroll target to the edge defined by the scroll bounds and starts scrolling in that direction. More...
 
bool isZoomEnabled () const
 Gets the value of the ZoomEnabledProperty. More...
 
void setZoomEnabled (bool value)
 Sets the value of the ZoomEnabledProperty. More...
 
float getZoom () const
 Gets the value of the ZoomProperty. More...
 
float getZoomMinimum () const
 Gets the value of the ZoomMinimumProperty. More...
 
void setZoomMinimum (float value)
 Sets the value of the ZoomMinimumProperty. More...
 
float getZoomMaximum () const
 Gets the value of the ZoomMaximumProperty. More...
 
void setZoomMaximum (float value)
 Sets the value of the ZoomMaximumProperty. More...
 
float getStepMultiplier () const
 Gets the value of the StepMultiplierProperty. More...
 
void setStepMultiplier (float value)
 Sets the value of the StepMultiplierProperty. More...
 
AllowedScrollAxis getAllowedScrollAxis () const
 Returns the value of the AllowedScrollAxisProperty. More...
 
void setAllowedScrollAxis (AllowedScrollAxis axis)
 Sets the value of the AllowedScrollAxisProperty. More...
 
void refreshThreshold ()
 Updates the recognition threshold of the pan manipulator to the value of the RecognitionThresholdProperty value. More...
 
- Public Member Functions inherited from kanzi::Node2D
virtual ~Node2D ()
 
ChildConstIterator beginChildren () const
 
ChildConstIterator endChildren () const
 
ChildConstReverseIterator rbeginChildren () const
 
ChildConstReverseIterator rendChildren () const
 
void addChild (Node2DSharedPtr child)
 Adds a child node. More...
 
void insertChild (size_t index, Node2DSharedPtr child)
 Adds a child node for object node to given index. More...
 
void removeChild (const Node &child)
 Removes child node. More...
 
void removeChild (size_t index)
 Removes child node at specified index. More...
 
void removeAllChildren ()
 Removes all child nodes. More...
 
Node2DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
size_t getChildCount () const
 Gets the number of children of the node. More...
 
void moveToBack ()
 Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
 
void moveToFront ()
 Repositions the node to the end of its parent's children, so that it is drawn last. More...
 
RenderType getRenderType () const
 Get render type. More...
 
BrushSharedPtr getBackgroundBrush () const
 Gets value of BackgroundBrushProperty. More...
 
void setBackgroundBrush (BrushSharedPtr value)
 Sets value of BackgroundBrushProperty. More...
 
BrushSharedPtr getCompositionBrush () const
 Gets value of CompositionBrushProperty. More...
 
void setCompositionBrush (BrushSharedPtr value)
 Sets value of CompositionBrushProperty. More...
 
BrushSharedPtr getForegroundBrush () const
 Gets value of ForegroundBrushProperty. More...
 
void setForegroundBrush (BrushSharedPtr value)
 Sets value of ForegroundBrushProperty. More...
 
BrushRenderergetBackgroundBrushRenderer () const
 Get background brush renderer. More...
 
BrushRenderergetForegroundBrushRenderer () const
 Get foreground brush renderer. More...
 
BrushRenderergetCacheChildrenBrushRenderer () const
 Access cache children brush renderer. More...
 
BrushRenderergetCacheSelfBrushRenderer () const
 Access cache self brush renderer. More...
 
BrushRenderergetCompositionBrushRenderer () const
 Access cache result brush renderer. More...
 
SRTValue2D getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (SRTValue2D value)
 Sets the value of RenderTransformationProperty. More...
 
SRTValue3D getPerspectiveTransformation () const
 Gets the value of PerspectiveTransformationProperty. More...
 
void setPerspectiveTransformation (SRTValue3D value)
 Sets the value of PerspectiveTransformationProperty. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack)
 Render individual 2D node. More...
 
NodeVisual2DgetVisual () const
 Access visual component. More...
 
TextureSharedPtr getRenderTarget () const
 Gets value of RenderTargetProperty. More...
 
void setRenderTarget (TextureSharedPtr texture)
 Sets value of RenderTargetProperty. More...
 
TextureSharedPtr getFinalCompositionTarget () const
 Returns composition target combining all Node2D content. More...
 
bool hasCacheChildren () const
 Tell if node should cache its children. More...
 
bool hasCacheChildrenCompositionTarget () const
 Tell if node has cache children composition target. More...
 
bool isCacheChildrenValid () const
 Tell if children cache is valid. More...
 
void resetCacheChildren ()
 Reset cached content for children. More...
 
bool hasCacheResult () const
 Tell if node should cache its result. More...
 
bool hasFinalCompositionTarget () const
 Tell if node has final composition target. More...
 
bool isCacheResultValid () const
 Tell if children cache is valid. More...
 
void resetCacheResult ()
 Reset cached content for complete node content including itself and its children. More...
 
bool hasCacheSelf () const
 Tell if node should cache itself. More...
 
bool hasCacheSelfCompositionTarget () const
 Tell if node has cache children composition target. More...
 
bool isCacheSelfValid () const
 Tell if children cache is valid. More...
 
void resetCacheSelf ()
 Reset cached content for node itself. More...
 
CompositionManagergetCompositionManager () const
 Access composition manager. More...
 
NodeCompositor2DgetCompositor () const
 Access compositor component. More...
 
void setAutoWidth ()
 Sets node to automatically determine width. More...
 
void setAutoHeight ()
 Sets node to automatically determine height. More...
 
void setAutoSize ()
 Sets node to automatically determine both width and height. More...
 
void setSize (float width, float height)
 Sets size properties of the node. More...
 
void setLayoutSize (float width, float height)
 Sets size properties of the node. More...
 
SRTValue2D getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (SRTValue2D value)
 Sets the value of LayoutTransformationProperty. More...
 
Vector2 getDesiredSize () const
 Get desired size. More...
 
void setDesiredSize (Vector2 size)
 Set desired size. More...
 
Vector2 getAllocatedSize () const
 Get allocated size. More...
 
void setAllocatedSize (Vector2 allocatedSize)
 Set allocated size. More...
 
Vector2 getActualSize () const
 Get actual size. More...
 
void setActualSize (Vector2 actualSize)
 Set actual size. More...
 
void setActualSize (float sizeX, float sizeY)
 Set actual size. More...
 
Matrix3x3 getArrangeTransform () const
 Get arrange transform. More...
 
void setArrangeTransform (Matrix3x3 transform)
 Set arrange transform. More...
 
void layout (optional< Matrix3x3 > rootTransform)
 Does layout pass starting from this node and iterating recursively all of its children. More...
 
void layout ()
 Does layout pass with no root transformation (identity). More...
 
bool measure (const Vector2 *availableSize, bool handleStretch)
 Measure one node. More...
 
virtual bool measureRecursive ()
 Perform measure recursively. More...
 
void arrange ()
 Arrange one Node2D. More...
 
void extract ()
 Extract one Node2D. More...
 
Matrix3x3 getWorldTransform () const
 Get world transform. More...
 
bool containsLocal (Vector2 point) const
 Tell if a node area contains a point (defined in node's own space). More...
 
optional< Vector2containsGlobal (Vector2 point) const
 Tell if a node area contains a point (defined in screen space). More...
 
optional< Vector2globalToLocal (Vector2 point) const
 
NodeSharedPtr hitTest (Vector2 point)
 Performs a hit test to a 2D node and all its child nodes. More...
 
NodeSharedPtr hitTest (Vector2 point, const Metaclass *type)
 Performs a hit test to a 2D node and all its child nodes. More...
 
NodeSharedPtr hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData)
 Recursively hit test nodes from this node downwards and call visitor function on nodes hit. More...
 
virtual tuple< NodeSharedPtr, KzcRay, float > hitTestContent (Vector2 point)
 Default implementation of Node2D content hit test. More...
 
template<typename T >
shared_ptr< T > hitTest (Vector2 point)
 Wrapper for hitTest(Vector2), casts the return value. More...
 
template<typename T >
shared_ptr< T > hitTest (Vector2 point, const Metaclass *type)
 Wrapper for hitTest(Vector2, const Metaclass), casts the return value. More...
 
virtual NodeSharedPtr findAbstractChildOverride (string_view name) KZ_OVERRIDE
 Node::findAbstractChildOverride() implementation. More...
 
virtual VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
 Node::visitAabstractChild implementation. More...
 
virtual bool addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE
 Node::addAbstractChildOverride() implementation. More...
 
virtual size_t getAbstractChildCountOverride () KZ_OVERRIDE
 Node::getAbstractChildCountOverride() implementation. More...
 
virtual NodeSharedPtr getAbstractChildOverride (size_t index) KZ_OVERRIDE
 Node::getAbstractChildOverride() implementation. More...
 
virtual bool removeAbstractChildOverride (Node &child) KZ_OVERRIDE
 Node::removeAbstractChildOverride() implementation. More...
 
bool compositionRequiresAlpha () const
 Tell if composition requires alpha. More...
 
void setCompositionRequiresAlpha (bool enabled)
 Turn composition alpha requirement on or off. More...
 
bool compositionRequiresDepth () const
 Tell if composition requires depth. More...
 
void setCompositionRequiresDepth (bool enabled)
 Turn composition depth requirement on or off. More...
 
bool compositionRequiresStencil () const
 Tell if composition requires stencil. More...
 
void setCompositionRequiresStencil (bool enabled)
 Turn composition stencil requirement on or off. More...
 
QuadDescription getBackgroundQuad () const
 Gets the background quad description. More...
 
ClippingArea getClippingArea () const
 Get clipping area. More...
 
float getLayoutOpacity () const
 Get opacity after propagation from layouting hierarchy. More...
 
Matrix3x3 getRenderQuadTransform () const
 Gets transformation used to render the 2D node. More...
 
bool hasCenterClipArea () const
 Tell if Node2D has the center clip area (the area of itself). More...
 
bool hasOutsideClipArea () const
 Tell if Node2D has outside clipping area. More...
 
bool hasTranslucentForeground () const
 Tell if Node2D foreground has translucency. More...
 
void setForegroundIsTranslucent (bool enabled)
 Set foreground translucency status. More...
 
void setFinalCompositionRequested (bool enabled)
 Turn composition request on or off. More...
 
bool isCompositionClearColorRequired () const
 Indicates whether composition target requires color clear before rendering. More...
 
bool isClearColorAllowed () const
 Indicates whether this Node2D is allowed and should clear the color buffer of its own composition target. More...
 
void setClearColorAllowed (bool enabled)
 Set clear color allowed. More...
 
bool isRenderChildrenAllowed () const
 Tell if rendering children is allowed. More...
 
bool isRenderSelfAllowed () const
 Tell if render self is allowed. More...
 
bool isVisibleForHitTesting () const
 Tell if Node2D is visible for hit testing. More...
 
bool requiresBackgroundBrushRendering () const
 Tell if background brush rendering is required. More...
 
bool requiresForegroundBrushRendering () const
 Tell if foreground brush rendering is required. More...
 
bool hasChildrenRequireExtract () const
 Tell if children require extract flag is on. More...
 
void setChildrenRequireExtract (bool enabled)
 Set children require extract flag. More...
 
bool requiresExtract () const
 Tell if node requires extraction. More...
 
void setRequiresExtract (bool enabled)
 Turn extract requirement on or off. More...
 
bool isSelfInCompositionTarget () const
 Tell if node itself is going to get rendered into a composition target. More...
 
Vector2 getContentDesiredSize () const
 Get size desired by content. More...
 
Vector2 getSecondPassDesiredSize () const
 Get second pass desired size. More...
 
Vector2 getUserDesiredSize () const
 Get size desired by user. More...
 
Matrix3x3 getPartialArrangeTransform () const
 Get partial arrange transform. More...
 
bool isCompletelyClipped () const
 Tell if node is completely clipped (and needs not be rendered). More...
 
bool isCompletelyTransparent () const
 Tell if node is completely transparent. More...
 
float getAspectRatio () const
 Gets the value of AspectRatioProperty. More...
 
void setAspectRatio (float value)
 Sets the value of AspectRatioProperty. More...
 
bool isForceComposition () const
 Gets the value of ForceCompositionProperty. More...
 
void setForceComposition (bool value)
 Sets the value of ForceCompositionProperty. More...
 
Node2D::ForegroundHint getForegroundHint () const
 Gets the value of ForegroundHintProperty. More...
 
void setForegroundHint (Node2D::ForegroundHint value)
 Sets the value of ForegroundHintProperty. More...
 
bool isCacheChildren () const
 Gets the value of CacheChildrenProperty. More...
 
void setCacheChildren (bool value)
 Sets the value of CacheChildrenProperty. More...
 
bool isCacheResult () const
 Gets the value of CacheResultProperty. More...
 
void setCacheResult (bool value)
 Sets the value of CacheResultProperty. More...
 
bool isCacheSelf () const
 Gets the value of CacheSelfProperty. More...
 
void setCacheSelf (bool value)
 Sets the value of CacheSelfProperty. More...
 
bool isOffscreenRendering () const
 Gets the value of OffscreenRenderingProperty. More...
 
void setOffscreenRendering (bool value)
 Sets the value of OffscreenRenderingProperty. More...
 
bool isDisableRenderTargetClear () const
 Gets the value of DisableRenderTargetClearProperty. More...
 
void setDisableRenderTargetClear (bool value)
 Sets the value of DisableRenderTargetClearProperty. More...
 
Node2D::PixelFormat getPixelFormat () const
 Gets the value of PixelFormatProperty. More...
 
void setPixelFormat (Node2D::PixelFormat value)
 Sets the value of PixelFormatProperty. More...
 
bool isRenderSelf () const
 Gets the value of RenderSelfProperty. More...
 
void setRenderSelf (bool value)
 Sets the value of RenderSelfProperty. More...
 
float getRenderTargetMinimumHeight () const
 Gets the value of RenderTargetMinimumHeightProperty. More...
 
void setRenderTargetMinimumHeight (float value)
 Sets the value of RenderTargetMinimumHeightProperty. More...
 
float getRenderTargetMinimumWidth () const
 Gets the value of RenderTargetMinimumWidthProperty. More...
 
void setRenderTargetMinimumWidth (float value)
 Sets the value of RenderTargetMinimumWidthProperty. More...
 
float getRenderTargetReallocationLimit () const
 Gets the value of RenderTargetReallocationLimitProperty. More...
 
void setRenderTargetReallocationLimit (float value)
 Sets the value of RenderTargetReallocationLimitProperty. More...
 
Vector2 getRenderTransformationOrigin () const
 Gets the value of RenderTransformationOriginProperty. More...
 
void setRenderTransformationOrigin (Vector2 value)
 Sets the value of RenderTransformationOriginProperty. More...
 
bool isSnapToPixel () const
 Gets the value of SnapToPixelProperty. More...
 
void setSnapToPixel (bool value)
 Sets the value of SnapToPixelProperty. More...
 
- Public Member Functions inherited from kanzi::Node
virtual ~Node ()
 Destructor. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where handler is a method to invoke on an object. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where filter is a method to invoke on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where handler is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where filter is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where handler is function and accepted source is explicitly defined. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message with specified arguments. More...
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 Tries to find Resource URL for Resource ID from this node. More...
 
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< T > acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource. More...
 
template<typename T >
shared_ptr< T > tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 Gets the resource dictionary of the node, if the node has one. More...
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets the resource dictionary of the node. More...
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree. More...
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of the node. More...
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Add a nested resource dictionary to the resource dictionary of the node. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
bool isNamed (string_view name) const
 
NodegetParent () const
 Returns the parent of the node. More...
 
void setParent (Node *parent)
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view path)
 Lookup for an object from a node. More...
 
template<typename TNodeType >
shared_ptr< TNodeType > findAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
 
void addInputManipulator (InputManipulatorSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
InputManipulatorConstIterator endInputManipulators () const
 
void addBinding (BindingSharedPtr binding)
 Transfers the ownership of a binding rule to an object node. More...
 
void addBindingWithOwner (BindingSharedPtr binding, shared_ptr< void > owner)
 Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More...
 
void removeBinding (Binding &binding)
 Removes the ownership and detaches a binding rule from an object node. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all bindings with the specified owner. More...
 
BindingConstIterator beginBindings () const
 
BindingConstIterator endBindings () const
 
void addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node. More...
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
NodeComponentConstIterator beginNodeComponents () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name. More...
 
void setRenderable (bool state)
 Sets whether the object node is renderable. More...
 
bool isRenderable () const
 Returns whether node is renderable. More...
 
bool isEffectivelyVisible () const
 Checks if the node and all of its ancestors are visible. More...
 
bool isEffectivelyEnabled () const
 Checks if the node and all of its ancestors are enabled. More...
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags is set. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void validateArrange ()
 Validates arrange. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
void validateRender ()
 Validates render for node. More...
 
void invalidateRender ()
 Invalidates render for node. More...
 
bool isInvalidFinalTransform () const
 Tells if final transform flag is invalid for node. More...
 
void invalidateFinalTransform ()
 Invalidates final transform for node. More...
 
bool isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
void invalidateDraw ()
 Invalidates draw flag for the node. More...
 
void validateDraw ()
 Validates draw flags for the node. More...
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards. More...
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise. More...
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants. More...
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise. More...
 
bool isDetaching () const
 Returns true if the node currently detaching. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
void detachRecursive ()
 Detaches an object node and its children recursively. More...
 
virtual const KzuBoundingVolumegetBoundingVolume () const
 Gets bounding volume from object node. More...
 
AppliedStyleEntrySharedPtr applyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
AppliedStyleEntrySharedPtr applyManualStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB, including properties, bindings, node comopnents, resources etc. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void removeNodeReference (const AbstractNodeReference &reference)
 
ScriptingContextSharedPtr getScriptingContext () const
 
void setScriptingContext (ScriptingContextSharedPtr context)
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node. More...
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node. More...
 
bool trySetActiveFocus ()
 The method tries to move the active focus on this node. More...
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string_view value)
 Sets the value of NameProperty. More...
 
string getPath () const
 Gets the value of PathProperty. More...
 
void setPath (string value)
 Sets the value of PathProperty. More...
 
string getLocale () const
 Gets the value of LocaleProperty. More...
 
void setLocale (string value)
 Sets the value of LocaleProperty. More...
 
bool isHitTestable () const
 Gets the value of HitTestableProperty. More...
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty. More...
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty. More...
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty. More...
 
bool isVisible () const
 Gets the value of VisibleProperty. More...
 
void setVisible (bool value)
 Sets the value of VisibleProperty. More...
 
bool isEnabled () const
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
bool isFocusable () const
 Gets the value of FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of FocusableProperty. More...
 
bool isFocused () const
 Gets the value of FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of FocusedProperty. More...
 
bool hasLogicalFocus () const
 Returns the #LogicalFocusedProperty value. More...
 
void setLogicalFocus (bool value)
 Sets the value of LogicalFocusProperty. More...
 
FontSharedPtr getFont () const
 Gets the value of FontProperty. More...
 
void setFont (FontSharedPtr value)
 Sets the value of FontProperty. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
bool isEnableClick () const
 Gets the value of EnableClickProperty. More...
 
void setEnableClick (bool value)
 Sets the value of EnableClickProperty. More...
 
bool isEnableMultiClick () const
 Gets the value of EnableMultiClickProperty. More...
 
void setEnableMultiClick (bool value)
 Sets the value of EnableMultiClickProperty. More...
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty. More...
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty. More...
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty. More...
 
void setStateManager (ResourceSharedPtr value)
 Sets the value of StateManagerProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
float getDepth () const
 Gets the value of DepthProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
float getActualWidth () const
 Gets the value of ActualWidthProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
float getActualHeight () const
 Gets the value of ActualHeightProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
float getActualDepth () const
 Gets the value of ActualDepthProperty. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty. More...
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty. More...
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty. More...
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty. More...
 
float getOpacity () const
 Gets the value of OpacityProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
bool isHover () const
 Returns whether the node has HoverProperty set to true. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static ScrollView2DSharedPtr create (Domain *domain, string_view name)
 Creates a Scroll View node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node2D
static float layoutUp ()
 
static bool isValidLayoutSize (Vector2 size)
 Indicates whether a size is valid layout size. More...
 
static Vector2 unboundedLayoutSize ()
 Returns an unbounded layout size. More...
 
static bool isUnboundedLayoutSize (Vector2 layoutSize)
 Indicates whether a layout size is an unbound layout size. More...
 
static Vector2 replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize)
 Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
 
static Vector2 replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize)
 Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value. More...
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value. More...
 
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value. More...
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it. More...
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::ScrollViewConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

 ScrollView2D (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
 ScrollViewConceptImpl (Domain *domain, string_view name)
 
ScrollView2DgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const ScrollView2DgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
void initialize ()
 Assigns the message handlers for the pan manipulator and scroll messages. More...
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 Node::onNodePropertyChanged() implementation. More...
 
void refreshScrollConfiguration ()
 Kanzi internally uses this helper function to update smooth interpolation coefficients between starting and stopping the interpolator timer, depending on whether a finger is still on a Scroll View node. More...
 
void refreshMinimumNumberOfTouches ()
 Kanzi internally uses this helper function to update the minimum number of touch points of the pan manipulator to the value of the MinimumNumberOfTouchesProperty value. More...
 
void refreshMaximumNumberOfTouches ()
 Kanzi internally updates the maximum number of touch points of the pan manipulator to the value of the MaximumNumberOfTouchesProperty value. More...
 
- Protected Member Functions inherited from kanzi::Node2D
 Node2D (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
NodeVisual2DacquireVisual ()
 Initializes and returns visual structure. More...
 
virtual void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack)
 Node-specific top-level render call. More...
 
void renderRecursive (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Render a Node2D and then recursively all its children. More...
 
virtual void renderSelfOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Node-specific rendering. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Render all children of a Node2D. More...
 
void renderBackground (Renderer3D &renderer, const CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Render background quad of a Node2D. More...
 
void renderForeground (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Render foreground of a Node2D. More...
 
virtual void renderForegroundOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
 Node-specific foreground render. More...
 
bool pushLocalViewportArea (CompositionStack &compositionStack)
 Push local viewport and scissor area into composition stack if it's required. More...
 
NodeCompositor2DacquireCompositor ()
 Initializes and returns composition structure. More...
 
void clearCompositionTarget (Renderer3D &renderer, CompositionStack &compositionStack, bool clearColor)
 Clear node render target. More...
 
virtual Vector2 measureOverride (Vector2 availableSize)
 Default implementation of Node2D size calculation. More...
 
virtual void arrangeRecursive (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool arrangeNeeded, bool transformChanged)
 Perform arrange recursively. More...
 
virtual void arrangeOverride (Vector2 actualSize)
 Default implementation of Node2D arrange. More...
 
optional< float > getUserAspectRatio () const
 Get aspect ratio property assigned to the node. More...
 
optional< float > getUserHeight () const
 Get layout height property assigned to the node. More...
 
optional< float > getUserWidth () const
 Get layout width property assigned to the node. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMinimum () const
 Get desired size axis aligned bounding box minimum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (Vector2 size)
 Set desired size axis aligned bounding box minimum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (float sizeX, float sizeY)
 Set desired size axis aligned bounding box minimum. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMaximum () const
 Get desired size axis aligned bounding box maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMaximum (Vector2 size)
 Set desired size axis aligned bounding box maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMaximum (float sizeX, float sizeY)
 Set desired size maximum. More...
 
void calculateTransformedBoundingArea (const Matrix3x3 &transform, Vector2 sizeIn)
 Calculate new transformed bounding area. More...
 
Matrix3x3 updateFinalTransform (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform)
 Update final transformation. More...
 
bool updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool transformChanged)
 Validate node for rendering. More...
 
virtual void updateRenderOverride ()
 Node-specific updates done before render. More...
 
optional< QuadDescriptioncalculateContentStretch (Vector2 renderSize, Vector2 contentSize)
 Calculate content stretch. More...
 
ClippingArea calculateClippingArea (const Matrix3x3 &parentSpaceTransform) const
 Calculate clipping parameters. More...
 
unsigned int performClipping (QuadDescription &backgroundQuad, optional< QuadDescription > &foregroundQuad, unsigned int clippingResult)
 Perform rectangle clipping. More...
 
void extractChildren () const
 Extract children of node, called from extraction implementations. More...
 
virtual void onExtract ()
 Node2D extract function. More...
 
virtual void onDetached () KZ_OVERRIDE
 Node::onDetached() implementation. More...
 
virtual void restoreResources () KZ_OVERRIDE
 Node::restoreResources() implementation. More...
 
bool isEmptyActualSize () const
 Tell if the size of the node is empty or invalid. More...
 
bool isForegroundHintOpaque () const
 Tell if foreground hint is opaque. More...
 
bool isForegroundHintTranslucent () const
 Tell if foreground hint is translucent. More...
 
bool isForegroundTranslucencyRequested () const
 Tell if foreground translucency has been requested. More...
 
void setForegroundTranslucencyRequested (bool enabled)
 Turn foreground translucency request on or off. More...
 
void setPartialArrangeTransform (Matrix3x3 transform)
 Sets partial arrange transform. More...
 
void setRenderChildrenAllowed (bool enabled)
 Turn render children on or off. More...
 
void setRenderSelfAllowed (bool enabled)
 Turn render self on or off. More...
 
void setRenderType (RenderType renderType)
 Set render type. More...
 
void updateContentTexture (TextureSharedPtr texture)
 Update content texture for the foreground brush. More...
 
void setSecondPassDesiredSize (Vector2 size)
 Set second pass desired size. More...
 
- Protected Member Functions inherited from kanzi::Node
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during scene graph tree connections. More...
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during scene graph tree disconnections. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) KZ_OVERRIDE
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
void onCopy (const PropertyObject &other)
 

Additional Inherited Members

- Public Types inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
typedef ScrollViewConceptImpl< Node2D, ScrollView2DTScrollView
 
- Public Types inherited from kanzi::Node2D
enum  PixelFormat { PixelFormatRgb, PixelFormatRgba }
 
enum  ForegroundHint { ForegroundHintNone, ForegroundHintTranslucent, ForegroundHintOpaque }
 Hint for foreground handling of nodes. More...
 
enum  RenderType { RenderTypeNone, RenderTypeTexture, RenderTypeManual, RenderTypeManualClipped }
 Node2D render type - affects elementary decisions about node rendering. More...
 
typedef Vector2 LayoutVectorType
 
typedef Matrix3x3 LayoutMatrixType
 
typedef vector< Node2DSharedPtrChildContainer
 Container type for children. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 Iterator type for children. More...
 
typedef ChildContainer::const_reverse_iterator ChildConstReverseIterator
 Reverse iterator type for children. More...
 
typedef NodeSharedPtr(* HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData)
 Hit test visitor function. More...
 
- Public Types inherited from kanzi::Node
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 
typedef kanzi::vector< Node::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef function< VisitorResult(Node &)> Visitor
 
typedef vector< InputManipulatorSharedPtrInputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef InputManipulatorContainer::iterator InputManipulatorIterator
 
typedef InputManipulatorContainer::const_iterator InputManipulatorConstIterator
 
typedef vector< BindingEntryBindingContainer
 Gets the bindings iterator. More...
 
typedef BindingContainer::iterator BindingIterator
 
typedef BindingContainer::const_iterator BindingConstIterator
 
typedef vector< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator. More...
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::ScrollViewConcept
enum  ScrollDirection { ScrollUp, ScrollDown, ScrollLeft, ScrollRight }
 Enumeration for the available directions when scrolling by step. More...
 
enum  AllowedScrollAxis { XAxis, YAxis, AllAxes }
 Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll. More...
 
enum  ScrollPage { ScrollPageUp, ScrollPageDown }
 Enumeration for the available directions when scrolling a Scroll View node by page. More...
 
enum  ScrollEdge { ScrollHome, ScrollEnd }
 Enumeration for the available directions when scrolling to the edge of a Scroll View. More...
 
enum  PanState { PanInitial, PanStarted, PanCancelling, PanCanceled }
 Enumeration for the state of pan. More...
 
- Static Public Attributes inherited from kanzi::Node2D
static PropertyType< float > AspectRatioProperty
 AspectRatio property. More...
 
static PropertyType< bool > ForceCompositionProperty
 ForceComposition property. More...
 
static PropertyType< Node2D::ForegroundHintForegroundHintProperty
 ForegroundHint property. More...
 
static PropertyType< bool > CacheChildrenProperty
 CacheChildren property. More...
 
static PropertyType< bool > CacheResultProperty
 CacheResult property. More...
 
static PropertyType< bool > CacheSelfProperty
 CacheSelf property. More...
 
static PropertyType< bool > OffscreenRenderingProperty
 OffscreenRendering property. More...
 
static PropertyType< bool > DisableRenderTargetClearProperty
 DisableRenderTargetClear property. More...
 
static PropertyType< Node2D::PixelFormatPixelFormatProperty
 PixelFormat property. More...
 
static PropertyType< bool > RenderSelfProperty
 RenderSelf property. More...
 
static PropertyType< ResourceSharedPtrRenderTargetProperty
 RenderTarget property. More...
 
static PropertyType< float > RenderTargetMinimumHeightProperty
 RenderTargetMinimumHeight property. More...
 
static PropertyType< float > RenderTargetMinimumWidthProperty
 RenderTargetMinimumWidth property. More...
 
static PropertyType< float > RenderTargetReallocationLimitProperty
 RenderTargetReallocationLimit property. More...
 
static PropertyType< SRTValue2DLayoutTransformationProperty
 LayoutTransformation property. More...
 
static PropertyType< SRTValue2DRenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< SRTValue3DPerspectiveTransformationProperty
 PerspectiveTransformation property. More...
 
static PropertyType< Vector2RenderTransformationOriginProperty
 RenderTransformationOrigin property. More...
 
static PropertyType< bool > SnapToPixelProperty
 SnapToPixel property. More...
 
static PropertyType< ResourceSharedPtrBackgroundBrushProperty
 BackgroundBrush property. More...
 
static PropertyType< ResourceSharedPtrCompositionBrushProperty
 CompositionBrush property. More...
 
static PropertyType< ResourceSharedPtrForegroundBrushProperty
 ForegroundBrush property. More...
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property. More...
 
static PropertyType< string > PathProperty
 Path property. More...
 
static PropertyType< string > LocaleProperty
 Locale property. More...
 
static PropertyType< bool > CreatedFromKZBProperty
 CreatedFromKZB property. More...
 
static PropertyType< bool > HitTestableProperty
 HitTestable property. More...
 
static PropertyType< bool > HitTestableContainerProperty
 HitTestableContainer property. More...
 
static PropertyType< bool > VisibleProperty
 Visible property. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property. More...
 
static PropertyType< bool > FocusableProperty
 The property specifies whether a node can get active focus and can participate in the focus chain navigation. More...
 
static PropertyType< bool > FocusedProperty
 Specifies that the node is the active focus node, which receives keyboard messages. More...
 
static PropertyType< bool > LogicalFocusProperty
 Specifies that the node has logical focus state. More...
 
static PropertyType< ResourceSharedPtrFontProperty
 Font property. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< bool > EnableClickProperty
 EnableClick property. More...
 
static PropertyType< bool > EnableMultiClickProperty
 EnableMultiClick property. More...
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property. More...
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 StateManager property. More...
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 
static PropertyType< float > WidthProperty
 Width property. More...
 
static PropertyType< float > HeightProperty
 Height property. More...
 
static PropertyType< float > DepthProperty
 Depth property. More...
 
static PropertyType< float > ActualWidthProperty
 ActualWidth property. More...
 
static PropertyType< float > ActualHeightProperty
 ActualHeight property. More...
 
static PropertyType< float > ActualDepthProperty
 ActualDepth property. More...
 
static PropertyType< Node::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2DepthMarginProperty
 Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< bool > HoverProperty
 Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property. More...
 
- Static Public Attributes inherited from kanzi::ScrollViewConcept
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 Scroll View sends this message when scrolling starts, regardless of how the scrolling started. More...
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 Scroll View sends this message when scrolling ends, regardless of how the scrolling ended. More...
 
static MessageType< UserScrollStartedMessageArgumentsUserScrollStartedMessage
 Scroll View sends this message when user interaction causes the scrolling to start. More...
 
static MessageType< UserScrollFinishedMessageArgumentsUserScrollFinishedMessage
 Scroll View sends this message when user interaction causes the scrolling to end. More...
 
static MessageType< ZoomedMessageArgumentsZoomedMessage
 Scroll View sends this message when zoom in or zoom out occurs. More...
 
static MessageType< ScrolledMessageArgumentsScrolledMessage
 Scroll View sends this message whenever the Scroll View node scrolls. More...
 
static MessageType< SnapRequestMessageArgumentsSnapRequestMessage
 Scroll View sends this message when scrolling stops, but the Scroll View node needs to snap to the nearest item. More...
 
static MessageType< ScrollDirectionMessageArgumentsScrollDirectionMessage
 Send this message to a Scroll View node to scroll one step in a given direction. More...
 
static MessageType< ScrollPageMessageArgumentsScrollPageMessage
 Send this message to a Scroll View node to scroll the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollEdgeMessageArgumentsScrollEdgeMessage
 Send this message to a Scroll View node to scroll to the top or bottom of that Scroll View node. More...
 
static MessageType< SetScrollTargetMessageArgumentsSetScrollTargetMessage
 Send this message to a Scroll View to scroll to a specific position in that Scroll View node. More...
 
static MessageType< SetScrollMessageArgumentsSetScrollMessage
 Send this message to a Scroll View to go a scroll position immediatelly without scrolling. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionXProperty
 Use the MessageArgumentScrollViewScrollPositionX argument to set the x axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionYProperty
 Use the MessageArgumentScrollViewScrollPositionY argument to set the y axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollPositionProperty
 Use the MessageArgumentScrollViewScrollPosition argument to set the x and y axis coordinates for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollSpeedProperty
 Use the MessageArgumentScrollViewScrollSpeed argument to set the scrolling speed of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollTargetProperty
 Use the MessageArgumentScrollViewScrollTarget argument to set the scroll target for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollDirectionProperty
 Use the MessageArgumentScrollViewScrollDirection argument to set the scrolling direction for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollPageProperty
 Use the MessageArgumentScrollViewScrollPage argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollEdgeProperty
 Use the MessageArgumentScrollViewScrollEdge argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges. More...
 
static PropertyType< float > MessageArgumentScrollViewZoomProperty
 Use the MessageArgumentScrollViewZoom argument to set the zoom level for a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapPositionProperty
 Use the MessageArgumentScrollViewSnapPosition argument to set the target of a snap request. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapDirectionProperty
 Use the MessageArgumentScrollViewSnapDirection argument to set the direction of a snap request. More...
 
static PropertyType< Vector2ScrollAxisProperty
 Use the Scroll Axis property to set the direction of the primary axis of a Scroll View node. More...
 
static PropertyType< float > RecognitionThresholdProperty
 Use the Recognition Threshold property to set the amount a pointing device must move for the scrolling to start on a Scroll View node. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 Use the Minimum Number Of Touches property to set the required number of touch points pressed for a Scroll View node pan to start. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 Use the Maximum Number Of Touches property to set the maximum number of touch points allowed for a Scroll View to pan. More...
 
static PropertyType< float > SensitivityProperty
 Use the Sensitivity property to sets the amount the position changes relative to the movement of the pointer that starts the swiping. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 Use the Sliding Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 Use the Sliding Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 Use the Dragging Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 Use the Dragging Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 Use the Dragging Impulse Factor property to set the amount of impulse generated from the pointing device movement when dragging a Scroll View node. More...
 
static PropertyType< float > SwipeDistanceProperty
 Use the Swipe Distance property to set the distance that a swipe sends the scroll value, relative to the pointing device speed. More...
 
static PropertyType< Vector2ScrollPositionProperty
 Use the Scroll Position property to set the value for the current scroll position. More...
 
static PropertyType< Vector2ScrollTargetPositionProperty
 Use the Scroll Target Position property to set the value for the current scroll target. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 Use the Scroll Speed property to set the current scroll speed. More...
 
static PropertyType< bool > ScrollingProperty
 Use the Scrolling property to find out whether a Scroll View node is currently scrolling. More...
 
static PropertyType< bool > ZoomAffectsScrollingProperty
 Use the Zoom Affects Scrolling property to set whether the scroll position is scaled according to the zoom level. More...
 
static PropertyType< Vector2ScrollBoundsMinimumProperty
 Use the Scroll Bounds Minimum property to set the coordinates of the top-left corner of the scroll bounds rectangle. More...
 
static PropertyType< Vector2ScrollBoundsMaximumProperty
 Use the Scroll Bounds Maximum property to set the coordinates of the bottom-right corner of the scroll bounds rectangle. More...
 
static PropertyType< bool > LoopingXEnabledProperty
 Use the Looping X Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. More...
 
static PropertyType< bool > LoopingYEnabledProperty
 Use the Looping Y Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. More...
 
static PropertyType< bool > ZoomEnabledProperty
 Use the Zoom Enabled property to set whether to install a pinch manipulator that generates zoom messages. More...
 
static PropertyType< float > ZoomProperty
 Use the Zoom property to set the current zoom level. More...
 
static PropertyType< float > ZoomMinimumProperty
 Use the Zoom Minimum property to set the minimum zoom level. More...
 
static PropertyType< float > ZoomMaximumProperty
 Use the Zoom Maximum property to set the maximum zoom level. More...
 
static PropertyType< float > StepMultiplierProperty
 Use the Step Multiplier property to set the smallest distance that a Scroll View scrolls. More...
 
static PropertyType< AllowedScrollAxisAllowedScrollAxisProperty
 Sets the axis on which you want to allow a Scroll View node to scroll. More...
 
- Protected Types inherited from kanzi::Node2D
enum  Node2DFlags {
  AllowClear, AllowRenderChildren, AllowRenderSelf, ForegroundIsTranslucent,
  ForegroundTranslucencyRequested, RequiresBackgroundQuad, RequiresExtract, ChildrenRequireExtract,
  Node2DFlagsBitCount
}
 Different Node2D flags for bit set. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw. More...
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage. More...
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
- Protected Attributes inherited from kanzi::Node2D
unique_ptr< NodeVisual2Dm_visual
 Visual information. More...
 
unique_ptr< NodeCompositor2Dm_compositor
 Composition and caching information. More...
 
QuadDescription m_backgroundQuadDescription
 Background clipping quad / composition quad description. More...
 
ClippingArea m_clipping
 Clipping parameters. More...
 
CompositionRequirements m_compositionRequirements
 Composition requirements for this 2D node. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Use the Scroll View 2D node to create an input plane to enable user input from gestures.

For example, you can use the scroll message with its parameters generated by a Scroll View node to move a map plane or rotate a mesh.

When you create a Scroll View node it does not have a visual shape and does not necessarily need visible content. You can use a Scroll View node as an interactive surface even when it does not have visible content. When a user interacts with a Scroll View node, the action generates a message that travels to the Scroll View node where you can define the behavior for that message.

Relative position within a Scroll View is called scroll position and a position to which a Scroll View is going to scroll is called scroll target. Scroll View nodes report changes of their scroll position using the ScrollViewConcept::ScrolledMessage message. For example, you can add actions to react to these messages to set the position of a node controlled by a Scroll View node according to the scrolling. Current scroll position can also be read from ScrollPositionProperty.

Scroll View 2D node has location, position, and size in 2D space. It registers user input in 2D coordinates within the area defined by the size of the Scroll View 2D node. Take this into account when you design interaction with a Scroll View 2D. For example, if you rotate a Scroll View 2D node, the scroll input gets distorted.

To use a Scroll View 2D node to pan a node, use the ScrolledMessage messages:

// Declare the variables you use to store the nodes in this example.
Node2DSharedPtr textNode;
// Define the handler function for the ScrollView2D.ScrolledMessage message which a Scroll View generates when it scrolls.
void onScrollViewScrolled(ScrollView2D::ScrollMessageArguments& messageArguments)
{
// Make a 2D vector out of the scroll position x and y axis coordinates of the Scroll View node.
Vector2 translation = Vector2(messageArguments.getScrollPositionX(), messageArguments.getScrollPositionY());
// Set the above 2D vector as a render translation of the Text Block 2D node that you pan with a Scroll View node.
textNode->setRenderTransformation(SRTValue2D::createTranslation(translation));
}
// Create the Scroll View which uses the ScrollView2D.ScrolledMessage message handler.
void exampleSetupScrollView2DScroll()
{
// Create a Scroll View 2D node and set its size.
scrollView = ScrollView2D::create(domain, "Scroll View");
scrollView->setLayoutSize(100.0f, 100.0f);
// Create a Text Block 2D node and attach it to the Scroll View 2D node.
textNode = TextBlock2D::create(domain, "Hello world!");
scrollView->addChild(textNode);
// Add a message handler for the ScrollView2D.ScrolledMessage message from the Scroll View 2D node.
scrollView->addMessageHandler(ScrollView2D::ScrolledMessage, bind(&ScrollView2DSnippet::onScrollViewScrolled, this, placeholders::_1));
}

To use a Scroll View 2D node to scale a node, use the ZoomedMessage messages:

// Define the handler function for the ScrollView2D.ZoomedMessage message which a Scroll View generates when it zooms.
void onScrollViewZoomed(ScrollView2D::ZoomedMessageArguments& messageArguments)
{
// Get the value for the amount of zoom from the ScrollView2D.ZoomedMessage message arguments.
float zoom = messageArguments.getZoom();
// Scale the Text Block 2D node based on the zoom read from the ZoomedMessage message.
textNode->setRenderTransformation(SRTValue2D::createScale(Vector2(zoom, zoom)));
}
// Create the Scroll View which uses the ScrollView2D.ZoomedMessage handler.
void exampleSetupScrollView2DZoom()
{
// Create Scroll View 2D node and set a size for it.
scrollView = ScrollView2D::create(domain, "Scroll View");
scrollView->setLayoutSize(100.0f, 100.0f);
// Create a Text Block 2D node and attach it to the Scroll View 2D node.
textNode = TextBlock2D::create(domain, "Hello world!");
scrollView->addChild(textNode);
// Add a message handler for the ScrollView2D.ZoomedMessage message from the Scroll View 2D node.
scrollView->addMessageHandler(ScrollView2D::ZoomedMessage, bind(&ScrollView2DSnippet::onScrollViewZoomed, this, placeholders::_1));
}

Finding out when scrolling starts or ends

You can find out when the scrolling of a Scroll View node starts or ends by subscribing to the Scroll View messages. Scroll View nodes send:

  • ScrollStartedMessage message when scrolling starts, regardless of how the scrolling started.
  • ScrollFinishedMessage message when scrolling ends, regardless of how the scrolling ended. Scrolling ends when the interpolators reach the target values and the current position no longer changes.
  • UserScrollStartedMessage message when user interaction causes the scrolling to start.
  • UserScrollFinishedMessage message when user interaction causes the scrolling to end. At this point the user interaction ended, but the scrolling movement can still continue.

Setting the scroll position of a Scroll View node

You can scroll to a specific position in a Scroll View node by sending a SetScrollMessage message to that Scroll View. When you send a SetScrollMessage message to a Scroll View, that Scroll View goes to that position in an instant. If scrolling to a position is in progress and the scroll target is different from the current scroll position, this message does not stop that scrolling.

When you want to change the values towards which the Scroll View interpolators are going, set the scroll target for that Scroll View. If the scroll target and the current scroll position do not match, a Scroll View node interpolates the scroll values towards the scroll target values. X and Y scroll values use separate interpolators and velocities.

To set the scroll position:

// Create the scroll position message arguments.
ScrollViewConcept::SetScrollMessageArguments args;
args.setScrollPosition(Vector2(50.0f, 25.0f));
// Send the message to set the scroll position.
scrollView2D->dispatchMessage(ScrollViewConcept::SetScrollMessage, args);

To set the scroll target and start scrolling to the position set by the target:

// Create the scroll target message arguments.
ScrollViewConcept::SetScrollTargetMessageArguments args;
args.setScrollTarget(Vector2(50.0f, 25.0f));
// Send the message to set the scroll target.
scrollView2D->dispatchMessage(ScrollViewConcept::SetScrollTargetMessage, args);
See also
For a 3D version of the Scroll View node, see ScrollView3D.
For a general description of the Scroll View node, see ScrollViewConcept.

Constructor & Destructor Documentation

kanzi::ScrollView2D::ScrollView2D ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the node belongs to.
nameThe name of the node.

Member Function Documentation

static ScrollView2DSharedPtr kanzi::ScrollView2D::create ( Domain domain,
string_view  name 
)
static

Creates a Scroll View node.

Parameters
domainThe domain the node belongs to.
nameThe name of the node.
static PropertyTypeEditorInfoSharedPtr kanzi::ScrollView2D::makeEditorInfo ( )
static
optional<Vector2> kanzi::ScrollView2D::calculatePanPosition ( const optional< Vector2 > &  point) const

Kanzi internally uses this function to calculate the pan position based on input point, compares it to the previous input point, and provides these values to the interpolators.

Parameters
pointThe point that comes from the input manipulator.
optional<Vector2> kanzi::ScrollView2D::calculatePanPosition ( const InputManipulator::InputMessageArguments arguments) const

Kanzi internally uses this function to extract input point from message arguments and calls calculatePanPosition(const optional<Vector2>& point).

Parameters
argumentsMessage arguments from the input manipulator.

The documentation for this class was generated from the following file: